Get schedule's Executions

{ getExecutions }

Returns the list of executions for a schedule

Method

/API2/tasks/getExecutions

  • API Section: /API2/tasks
  • API Version: 2.0
  • From Release: 2018.5
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
    • Domain Admin
    • Pro
    • Analyst
    • Viewer
    • Input Parameters

    Name

    scheduleId

    Type

    string

    Description

    The schedule's system ID

    Output Response

    Successful Result Code

    200

    Response List Type

    ExecutionViewData[]

    Description of Response Type

    The execution object contains all the details of scheduled execution instance.. Note that the response is returned as a list of items of this object type.

    Notes

    An 'Execution' is the event crated each time a schedule is launched. Each execution will spawn 'tasks' or jobs to be completed.